Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ac/package updates #2

Merged

Conversation

annacasavant
Copy link
Contributor

@annacasavant annacasavant commented Nov 6, 2024

-Changed the name of package to SiennaTemplate.jl
-added Diataxis guidelines for documentation
-updated to Documenter 1.0
-updated formatter.jl
@kdayday
@jd-lara

Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
SiennaTemplate = "bed98974-b02a-5e2f-9ee0-a103f5c450dd"

[compat]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a requirement for:
Documenter = "1"

docs/make.jl Outdated Show resolved Hide resolved

------------
SIIP-PACKAGE has been developed as part of the Scalable Integrated Infrastructure Planning
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we replace this with the same About stub from power systems?

Screenshot 2024-11-08 at 2 03 05 PM

docs/Project.toml Show resolved Hide resolved
docs/make.jl Show resolved Hide resolved
Copy link

@kdayday kdayday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Couple last changes. Remind me, are you able to compile the docs for this one?

.github/pull_request_template.md Outdated Show resolved Hide resolved
Check the [contributor guidelines](https://nrel-siip.github.io/SIIP-PACKAGE.jl/stable/code_base_developer_guide/developer/)
Thanks for opening a PR to SIIP-PACKAGE.jl, please take note of the following when making a PR:

Check the [contributor guidelines](https://nrel-siip.github.io/SIIP-PACKAGE.jl/stable/code_base_developer_guide/developer/)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reference will fail, since we don't have this page. Could you follow the format in PowerSystems to add a Reference > Developers > Developer Guildlines page? https://nrel-sienna.github.io/PowerSystems.jl/stable/api/developer_guidelines/

The Internals API can also go in the Developers subsection.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The url will need to be updated to point to the new Developer Guidelines page.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we delete this file? It's not being mapped in the make.jl anymore, correct?

Copy link

@kdayday kdayday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job!

@annacasavant annacasavant marked this pull request as ready for review November 25, 2024 23:17
@jd-lara jd-lara changed the base branch from main to jd/merge_ac_changes November 25, 2024 23:37
@jd-lara
Copy link
Member

jd-lara commented Nov 25, 2024

@annacasavant and @kdayday the conflicts need to be fixed to merge this.

@jd-lara jd-lara merged commit 964c372 into NREL-Sienna:jd/merge_ac_changes Nov 26, 2024
3 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants